Inside Macintosh: QuickDraw GX Objects /

Chapter 7 - View-Related Objects / View-Related Objects Reference

View Port Functions / Manipulating View Port Object Properties

GXGetViewPortChildren

You can use the GXGetViewPortChildren function to retrieve the list of child view ports of a view port object.

long GXGetViewPortChildren(gxViewPort source, gxViewPort list[]);

source

A reference to the view port whose child view ports you wish to examine.

list

An array of view port references. On return, contains the child view port list of the source view port.

function result

The number of references in the child view port list of the source view port.

DESCRIPTION

The GXGetViewPortChildren function retrieves the list of child view ports of the source view port. It also returns, as its function result, the number of references in the list. The list and the number returned by this function do not include children of children.

The view ports are placed in the list array in the order they were added as children.

If you set the list parameter to nil, GXGetViewPortChildren does not retrieve a list of references; it only returns the number of child view port objects. Therefore, you typically call this function twice: first to get the size of array to allocate for the list parameter, and second to retrieve the list itself.

ERRORS, WARNINGS, AND NOTICES

Errors
invalid_viewPort_reference

SEE ALSO

For information about view port hierarchies and the child view port list property, see "Parent and Child View Ports" beginning on page 7-18.

To set the child view port list of a view port, use the GXSetViewPortChildren function, described next.

To get the parent of a view port, use the GXGetViewPortParent function, described on page 7-84. To set the parent of a view port, use the GXSetViewPortParent function, described in the previous section.

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help